Add skeleton for new websockets stream api docs #1074
Conversation
* Added a single page overiview docs * Added a multi-page detailed docs for each message type
|
@illia-malachyn is attempting to deploy a commit to the Flow Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
docs/networks/node-ops/access-onchain-data/access-nodes/accessing-data/websockets-stream-api.md
Outdated
Show resolved
Hide resolved
|
@illia-malachyn the deployed vercel from a few days ago is here. With the left nav we probably want a top label that is more readable than "websockets-stream-api". This nav option is also distinct from the written title of 'Websockets Stream API'. My guess is the intention was for the sub pages to be under that root, not the 'websockets-stream-api' one 
|
|
Nav looks good in latest vercel deployment. Looks like there's still more to be added and we should wait to merge this only once the functionality is deployed and live. |
| Use any WebSocket client library to connect to the endpoint. Below is an example using JavaScript: | ||
|
|
||
| ```javascript | ||
| const ws = new WebSocket('wss://api.flow.com/ws'); |
There was a problem hiding this comment.
let's use the correct url or an obviously fake one.
There was a problem hiding this comment.
what is it ? wss://rest-mainnet.onflow.org/ws ?
| - Each connection supports up to 10 concurrent subscriptions. Exceeding this limit will result in an error. | ||
| - Each subscription may provide up to 5 responses per second. | ||
| - After 1 minute of inactivity (no data is sent to/read from connection) connection is closed. |
There was a problem hiding this comment.
we should make all of these configurable, and just list the values used on the public access nodes here.
There was a problem hiding this comment.
Should I use up-to-date values here, or provide a link to the code where the defaults are set, or maybe scrap the values from the flow-go repo ?
...s/node-ops/access-onchain-data/access-nodes/accessing-data/websockets-stream-api/overview.md
Outdated
Show resolved
Hide resolved
...s/node-ops/access-onchain-data/access-nodes/accessing-data/websockets-stream-api/overview.md
Outdated
Show resolved
Hide resolved
...s/access-onchain-data/access-nodes/accessing-data/websockets-stream-api/subscribe-message.md
Outdated
Show resolved
Hide resolved
...s/access-onchain-data/access-nodes/accessing-data/websockets-stream-api/subscribe-message.md
Outdated
Show resolved
Hide resolved
...access-onchain-data/access-nodes/accessing-data/websockets-stream-api/unsubscribe-message.md
Outdated
Show resolved
Hide resolved
...onchain-data/access-nodes/accessing-data/websockets-stream-api/list-subscriptions-message.md
Outdated
Show resolved
Hide resolved
...s/access-onchain-data/access-nodes/accessing-data/websockets-stream-api/subscribe-message.md
Outdated
Show resolved
Hide resolved
...s/access-onchain-data/access-nodes/accessing-data/websockets-stream-api/subscribe-message.md
Outdated
Show resolved
Hide resolved
|
@illia-malachyn you will need to merge from main since the project structure for the docs in this area changed. Also, we need to make sure this section is also updated: https://developers.flow.com/networks/access-onchain-data#subscriptions |
Closes onflow/flow-go#6644
This is in progress and is postponed till we finish with websockets epic. However, you can review it and write notes about it.
What to add to: